home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2009 February / PCWFEB09.iso / Software / Linux / SLAX 6.0.8 / slax-6.0.8.iso / slax / base / 006-devel.lzm / usr / include / libkcal / todo.h < prev    next >
Encoding:
C/C++ Source or Header  |  2008-02-13  |  7.6 KB  |  243 lines
  1. /*
  2.     This file is part of libkcal.
  3.  
  4.     Copyright (c) 2001-2003 Cornelius Schumacher <schumacher@kde.org>
  5.  
  6.     This library is free software; you can redistribute it and/or
  7.     modify it under the terms of the GNU Library General Public
  8.     License as published by the Free Software Foundation; either
  9.     version 2 of the License, or (at your option) any later version.
  10.  
  11.     This library is distributed in the hope that it will be useful,
  12.     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13.     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14.     Library General Public License for more details.
  15.  
  16.     You should have received a copy of the GNU Library General Public License
  17.     along with this library; see the file COPYING.LIB.  If not, write to
  18.     the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  19.     Boston, MA 02110-1301, USA.
  20. */
  21. #ifndef KCAL_TODO_H
  22. #define KCAL_TODO_H
  23.  
  24. #include "incidence.h"
  25.  
  26. namespace KCal {
  27.  
  28. /**
  29.   This class provides a Todo in the sense of RFC2445.
  30. */
  31. class LIBKCAL_EXPORT Todo : public Incidence
  32. {
  33.   public:
  34.     typedef ListBase<Todo> List;
  35.  
  36.     Todo();
  37.     Todo( const Todo & );
  38.     ~Todo();
  39.     Todo& operator=( const Todo& );
  40.     bool operator==( const Todo& ) const;
  41.  
  42.     QCString type() const { return "Todo"; }
  43.  
  44.     /**
  45.       Returns an exact copy of this todo. The returned object is owned by the
  46.       caller.
  47.     */
  48.     Todo *clone();
  49.  
  50.     /**
  51.       Sets due date and time.
  52.  
  53.       @param dtDue The due date/time.
  54.       @param first Set the date of the first occurrence (if the todo is recurrent).
  55.     */
  56.     void setDtDue(const QDateTime &dtDue, bool first = false);
  57.     /**
  58.       Returns due date and time.
  59.  
  60.       @param first If true and the todo recurs, the due date of the first
  61.       occurrence will be returned.If false and recurrent, the date of the
  62.       current occurrence will be returned. If non-recurrent, the normal due date
  63.       will be returned.
  64.     */
  65.     QDateTime dtDue( bool first = false ) const;
  66.     /**
  67.       Returns due time as string formatted according to the users locale
  68.       settings.
  69.     */
  70.     QString dtDueTimeStr() const;
  71.     /**
  72.       Returns due date as string formatted according to the users locale
  73.       settings.
  74.  
  75.       @param shortfmt If set to true, use short date format, if set to false use
  76.                       long format.
  77.     */
  78.     QString dtDueDateStr( bool shortfmt = true ) const;
  79.     /**
  80.       Returns due date and time as string formatted according to the users locale
  81.       settings.
  82.     */
  83.     QString dtDueStr() const;
  84.  
  85.     /**
  86.       Returns true if the todo has a due date, otherwise return false.
  87.     */
  88.     bool hasDueDate() const;
  89.     /**
  90.       Set if the todo has a due date.
  91.  
  92.       @param hasDueDate true if todo has a due date, otherwise false
  93.     */
  94.     void setHasDueDate( bool hasDueDate );
  95.  
  96.     /**
  97.       Returns true if the todo has a start date, otherwise return false.
  98.     */
  99.     bool hasStartDate() const;
  100.     /**
  101.       Set if the todo has a start date.
  102.  
  103.       @param hasStartDate true if todo has a start date, otherwise false
  104.     */
  105.     void setHasStartDate( bool hasStartDate );
  106.  
  107.     /**
  108.       Returns the startdate of the todo.
  109.       @param first If true, the startdate of the todo will be returned. If the
  110.       todo recurs, the startdate of the first occurrence will be returned.
  111.       If false and the todo recurs, the relative startdate will be returned,
  112.       based on the date returned by dtRecurrence().
  113.     */
  114.     QDateTime dtStart( bool first = false ) const;
  115.  
  116.     /**
  117.       Sets the startdate of the todo.
  118.     */
  119.     void setDtStart( const QDateTime &dtStart );
  120.  
  121.     /** Returns an todo's starting time as a string formatted according to the
  122.      users locale settings.
  123.      @param first If true, the startdate of the todo will be returned. If the
  124.      todo recurs, the startdate of the first occurrence will be returned.
  125.      If false and the todo recurs, the relative startdate will be returned,
  126.      based on the date returned by dtRecurrence().
  127.     */
  128.     QString dtStartTimeStr( bool first = false ) const;
  129.     /** Returns an todo's starting date as a string formatted according to the
  130.      users locale settings.
  131.      @param shortfmt If true, use short date format, if set to false use
  132.      long format.
  133.      @param first If true, the startdate of the todo will be returned. If the
  134.      todo recurs, the startdate of the first occurrence will be returned.
  135.      If false and the todo recurs, the relative startdate will be returned,
  136.      based on the date returned by dtRecurrence().
  137.     */
  138.     QString dtStartDateStr( bool shortfmt = true, bool first = false ) const;
  139.     /** Returns an todo's starting date and time as a string formatted according
  140.      to the users locale settings.
  141.      @param first If true, the startdate of the todo will be returned. If the
  142.      todo recurs, the startdate of the first occurrence will be returned.
  143.      If false and the todo recurs, the relative startdate will be returned,
  144.      based on the date returned by dtRecurrence().
  145.     */
  146.     QString dtStartStr( bool first = false ) const;
  147.  
  148.     /**
  149.       Returns true if the todo is 100% completed, otherwise return false.
  150.     */
  151.     bool isCompleted() const;
  152.     /**
  153.       Set completed state.
  154.  
  155.       @param completed If true set completed state to 100%, if false set
  156.                        completed state to 0%.
  157.     */
  158.     void setCompleted( bool completed );
  159.  
  160.     /**
  161.       Returns how many percent of the task are completed. Returns a value
  162.       between 0 and 100.
  163.     */
  164.     int percentComplete() const;
  165.     /**
  166.       Set how many percent of the task are completed. Valid values are in the
  167.       range from 0 to 100.
  168.     */
  169.     void setPercentComplete( int );
  170.  
  171.     /**
  172.       Returns date and time when todo was completed.
  173.     */
  174.     QDateTime completed() const;
  175.     /**
  176.       Returns string contaiting date and time when the todo was completed
  177.       formatted according to the users locale settings.
  178.     */
  179.     QString completedStr() const;
  180.     /**
  181.       Set date and time of completion.
  182.     */
  183.     void setCompleted( const QDateTime &completed );
  184.  
  185.     /**
  186.       Returns true, if todo has a date associated with completion, otherwise
  187.       return false.
  188.     */
  189.     bool hasCompletedDate() const;
  190.  
  191.     /**
  192.       Sets the due date/time of the current occurrence if recurrent.
  193.     */
  194.     void setDtRecurrence( const QDateTime &dt );
  195.  
  196.     /**
  197.       Returns the due date/time of the current occurrence if recurrent.
  198.     */
  199.     QDateTime dtRecurrence() const;
  200.  
  201.     /**
  202.       Returns true if the date specified is one on which the todo will
  203.       recur. Todo's are a special case, hence the overload. It adds an extra
  204.       check, which make it return false if there's an occurrence between
  205.       the recurstart and today.
  206.     */
  207.     virtual bool recursOn( const QDate &date ) const;
  208.  
  209.     /**
  210.       Returns true if this todo is overdue (e.g. due date is lower than today
  211.       and not completed), else false.
  212.      */
  213.       bool isOverdue() const;
  214.  
  215.   protected:
  216.     /** Return the end date/time of the base incidence. */
  217.     virtual QDateTime endDateRecurrenceBase() const { return dtDue(); }
  218.  
  219.   private:
  220.     bool accept(Visitor &v) { return v.visit( this ); }
  221.     /** Returns true if the todo got a new date, else false will be returned. */
  222.     bool recurTodo();
  223.  
  224.     QDateTime mDtDue;                    // due date of todo
  225.                                          // (first occurrence if recurrent)
  226.     QDateTime mDtRecurrence;             // due date of recurrence
  227.  
  228.     bool mHasDueDate;                    // if todo has associated due date
  229.     bool mHasStartDate;                  // if todo has associated start date
  230.  
  231.     QDateTime mCompleted;
  232.     bool mHasCompletedDate;
  233.  
  234.     int mPercentComplete;
  235.  
  236.     class Private;
  237.     Private *d;
  238. };
  239.  
  240. }
  241.  
  242. #endif
  243.